<?php
namespace TYPO3\CMS\Backend\Sprite;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\PathUtility;

/**
 * An abstract class implementing SpriteIconGeneratorInterface.
 * Provides base functionality for all handlers.
 * @deprecated since TYPO3 CMS 7, will be removed with TYPO3 CMS 8
 */
abstract class AbstractSpriteHandler implements SpriteIconGeneratorInterface
{
    /**
     * all "registered" icons available through sprite API will cumulated here
     *
     * @var array
     */
    protected $iconNames = array();

    /**
     * contains the content of the CSS file to write
     *
     * @var string
     */
    protected $styleSheetData = '';

    /**
     * path to CSS file for generated styles
     *
     * @var string
     */
    protected $cssTcaFile = '';

    /**
     * constructor just init's the temp-file-name
     *
     * @deprecated since TYPO3 CMS 7, will be removed with TYPO3 CMS 8
     */
    public function __construct()
    {
        // The file name is prefixed with "z" since the concatenator orders files per name
        $this->cssTcaFile = PATH_site . SpriteManager::$tempPath . 'zextensions.css';
        $this->styleSheetData = '/* Auto-Generated via ' . get_class($this) . ' */' . LF;
    }

    /**
     * Loads all stylesheet files registered through
     * \TYPO3\CMS\Backend\Sprite\SpriteManager::addIconSprite
     *
     * In fact the stylesheet-files are copied to \TYPO3\CMS\Backend\Sprite\SpriteManager::tempPath
     * where they automatically will be included from via
     * \TYPO3\CMS\Backend\Template\DocumentTemplate and
     * \TYPO3\CMS\Core\Resource\ResourceCompressor
     *
     * @return void
     */
    protected function loadRegisteredSprites()
    {
        // Saves which CSS Files are currently "allowed to be in place"
        $allowedCssFilesinTempDir = array(basename($this->cssTcaFile));
        // Process every registeres file
        foreach ((array)$GLOBALS['TBE_STYLES']['spritemanager']['cssFiles'] as $file) {
            $fileName = basename($file);
            // File should be present
            $allowedCssFilesinTempDir[] = $fileName;
            // get-Cache Filename
            $fileStatus = stat(PATH_site . $file);
            $unique = md5($fileName . $fileStatus['mtime'] . $fileStatus['size']);
            $cacheFile = PATH_site . SpriteManager::$tempPath . $fileName . $unique . '.css';
            if (!file_exists($cacheFile)) {
                copy(PATH_site . $file, $cacheFile);
            }
        }
        // Get all .css files in dir
        $cssFilesPresentInTempDir = GeneralUtility::getFilesInDir(PATH_site . SpriteManager::$tempPath, '.css', 0);
        // and delete old ones which are not needed anymore
        $filesToDelete = array_diff($cssFilesPresentInTempDir, $allowedCssFilesinTempDir);
        foreach ($filesToDelete as $file) {
            unlink(PATH_site . SpriteManager::$tempPath . $file);
        }
    }

    /**
     * Interface function. This will be called from the sprite manager to
     * refresh all caches.
     *
     * @return void
     */
    public function generate()
    {
        // Include registered Sprites
        $this->loadRegisteredSprites();
        // Cache results in the CSS file
        GeneralUtility::writeFile($this->cssTcaFile, $this->styleSheetData);
    }

    /**
     * Returns the detected icon-names which may be used through
     * \TYPO3\CMS\Backend\Utility\IconUtility::getSpriteIcon.
     *
     * @return array all generated and registered sprite-icon-names, will be empty if there are none
     */
    public function getAvailableIconNames()
    {
        return $this->iconNames;
    }

    /**
     * this method creates sprite icon names for all tables in TCA (including their possible type-icons)
     * where there is no "typeicon_classes" of this TCA table ctrl section
     * (moved form \TYPO3\CMS\Backend\Utility\IconUtility)
     *
     * @return array Array as $iconName => $fileName
     */
    protected function collectTcaSpriteIcons()
    {
        $tcaTables = array_keys($GLOBALS['TCA']);
        $resultArray = array();
        // Path (relative from typo3 dir) for skin-Images
        if (isset($GLOBALS['TBE_STYLES']['skinImgAutoCfg']['relDir'])) {
            $skinPath = $GLOBALS['TBE_STYLES']['skinImgAutoCfg']['relDir'];
        } else {
            $skinPath = '';
        }
        // check every table in the TCA, if an icon is needed
        foreach ($tcaTables as $tableName) {
            // This method is only needed for TCA tables where
            // typeicon_classes are not configured
            if (is_array($GLOBALS['TCA'][$tableName]) && !is_array($GLOBALS['TCA'][$tableName]['ctrl']['typeicon_classes'])) {
                $tcaCtrl = $GLOBALS['TCA'][$tableName]['ctrl'];
                // Adding the default Icon (without types)
                if (isset($tcaCtrl['iconfile'])) {
                    // In CSS we need a path relative to the css file
                    // [TCA][ctrl][iconfile] defines icons without path info to reside in gfx/i/
                    if (\TYPO3\CMS\Core\Utility\StringUtility::beginsWith($tcaCtrl['iconfile'], 'EXT:')) {
                        list($extensionKey, $relativePath) = explode('/', substr($tcaCtrl['iconfile'], 4), 2);
                        $pathInfo = PathUtility::pathinfo(\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath($extensionKey) . $relativePath);
                        $path = PathUtility::getRelativePathTo($pathInfo['dirname']);
                        $icon = $path . $pathInfo['basename'];
                    } elseif (strpos($tcaCtrl['iconfile'], '/') !== false) {
                        $icon = $tcaCtrl['iconfile'];
                        $icon = GeneralUtility::resolveBackPath($icon);
                    } else {
                        $icon = $skinPath . 'gfx/i/' . $tcaCtrl['iconfile'];
                        $icon = GeneralUtility::resolveBackPath($icon);
                    }

                    $resultArray['tcarecords-' . $tableName . '-default'] = $icon;
                }
            }
        }
        return $resultArray;
    }
}
